[rustdoc] List matching impls on type aliases #112429

GuillaumeGomez · 2023-06-08T17:53:32Z

Fixes #32077.

Thanks a lot to @lcnr who helped me a lot with this fix!

src/librustdoc/html/render/print_item.rs

notriddle · 2023-06-08T18:33:55Z

src/librustdoc/html/render/mod.rs

 fn render_assoc_items_inner(
    mut w: &mut dyn fmt::Write,
    cx: &mut Context<'_>,
    containing_item: &clean::Item,
    it: DefId,
    what: AssocItemRender<'_>,
    derefs: &mut DefIdSet,
+    aliased_type: Option<DefId>,


I'm sure threading this parameter through all these function calls is probably cheaper than using let is_alias = tcx.def_kind(it) == DefKind::TyAlias and using let aliased_type = tcx.type_of(it) to resolve it, since the calling functions already have this information.

But is pulling the information out of TyCtxt expensive enough to be worth having a function with seven parameters?

We need a variable to tell us that this is an alias. From this, since we already have the DefId, why not using it directly?

EDIT: Just re-read your comment. I'm not sure to like it much simply because we re-compute an information we already have. But that's pretty much my only argument against it. ^^'

I edited my comment, I don't know how but I misread your comment the first time. Sorry about that.

There's not a lot of computation going into it, though. It's looking information up in a hash table.

It's not the part worrying me but since I can't put the finger on it, I'll just remove the newly added argument and let's see how it goes. :)

Ah found it! I need it because of Some(aliased_type) => cache.impls.get(&aliased_type).unwrap_or(&empty),. We can't retrieve the DefId easily from a Ty. The only method I found to get it is ty_adt_id but it doesn't cover all the cases we need.

That makes sense. Thanks for the info!

Having aliased_type separately here feels off to me and may at least deserve a comment, but that's unrelated to the type system itself so I am fine with that.

The doc comment for aliased_type is already on the function. ;)

notriddle · 2023-06-08T23:35:40Z

@bors r+

bors · 2023-06-08T23:35:42Z

📌 Commit cca7a31f98358a46679b4a9d821bdb8a4fa08483 has been approved by notriddle

It is now in the queue for this repository.

notriddle · 2023-06-08T23:43:46Z

Wait, no. You wanted a review from @lcnr

@bors r-

lcnr

r=me after nit

src/librustdoc/html/render/mod.rs

lcnr · 2023-06-09T06:57:02Z

src/librustdoc/html/render/mod.rs

 fn render_assoc_items_inner(
    mut w: &mut dyn fmt::Write,
    cx: &mut Context<'_>,
    containing_item: &clean::Item,
    it: DefId,
    what: AssocItemRender<'_>,
    derefs: &mut DefIdSet,
+    aliased_type: Option<DefId>,


Having aliased_type separately here feels off to me and may at least deserve a comment, but that's unrelated to the type system itself so I am fine with that.

GuillaumeGomez · 2023-06-09T09:18:17Z

@bors r=notriddle,lcnr

bors · 2023-06-09T09:18:19Z

📌 Commit 2ce7cd9 has been approved by notriddle,lcnr

It is now in the queue for this repository.

…otriddle,lcnr [rustdoc] List matching impls on type aliases Fixes rust-lang#32077. Thanks a lot to `@lcnr` who helped me a lot with this fix! cc `@notriddle` r? `@lcnr`

…llaumeGomez Rollup of 3 pull requests Successful merges: - rust-lang#112260 (Improve document of `unsafe_code` lint) - rust-lang#112429 ([rustdoc] List matching impls on type aliases) - rust-lang#112442 (Deduplicate identical region constraints in new solver) r? `@ghost` `@rustbot` modify labels: rollup

[rustdoc] Fix infinite loop when retrieving impls for type alias Fixes rust-lang#112515. Reverts rust-lang#112429. r? `@lcnr`

…l-list, r=GuillaumeGomez rustdoc: list matching impls on type aliases Fixes rust-lang#32077 Fixes rust-lang#99952 Remake of rust-lang#112429 Partially reverts rust-lang#112543, but keeps the test case. This version of the PR avoids the infinite loop by structurally matching types instead of using full unification. This version does not support type alias trait bounds, but the compiler does not enforce those anyway (rust-lang#21903). r? `@GuillaumeGomez` CC `@lcnr`

Rollup merge of rust-lang#115201 - notriddle:notriddle/type-alias-impl-list, r=GuillaumeGomez rustdoc: list matching impls on type aliases Fixes rust-lang#32077 Fixes rust-lang#99952 Remake of rust-lang#112429 Partially reverts rust-lang#112543, but keeps the test case. This version of the PR avoids the infinite loop by structurally matching types instead of using full unification. This version does not support type alias trait bounds, but the compiler does not enforce those anyway (rust-lang#21903). r? `@GuillaumeGomez` CC `@lcnr`

rustbot assigned lcnr Jun 8, 2023

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 8, 2023

This comment has been minimized.

Sign in to view

notriddle reviewed Jun 8, 2023

View reviewed changes

GuillaumeGomez force-pushed the ty-alias-impls branch from 07a00fe to cca7a31 Compare June 8, 2023 20:48

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 8, 2023

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jun 8, 2023

lcnr reviewed Jun 9, 2023

View reviewed changes

GuillaumeGomez added 3 commits June 9, 2023 10:36

List matching impls on type aliases

4b1d13d

Add regression test for rust-lang#32077

6f552c8

Fix intra-doc links from pointer appearing in windows HANDLE type alias

2ce7cd9

GuillaumeGomez force-pushed the ty-alias-impls branch from cca7a31 to 2ce7cd9 Compare June 9, 2023 08:36

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 9, 2023

This was referenced Jun 9, 2023

Rollup of 3 pull requests #112462

Closed

Rollup of 3 pull requests #112465

Merged

bors merged commit f83c8e4 into rust-lang:master Jun 9, 2023

rustbot added this to the 1.72.0 milestone Jun 9, 2023

GuillaumeGomez deleted the ty-alias-impls branch June 9, 2023 18:54

fmease mentioned this pull request Jun 11, 2023

rustdoc on nightly freezes when generating docs for typenum #112515

Closed

GuillaumeGomez restored the ty-alias-impls branch June 12, 2023 09:07

GuillaumeGomez deleted the ty-alias-impls branch June 12, 2023 09:07

GuillaumeGomez mentioned this pull request Jun 12, 2023

[rustdoc] Fix infinite loop when retrieving impls for type alias #112543

Merged

bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 12, 2023

Auto merge of rust-lang#112543 - GuillaumeGomez:revert-112429, r=lcnr

cb882fa

[rustdoc] Fix infinite loop when retrieving impls for type alias Fixes rust-lang#112515. Reverts rust-lang#112429. r? `@lcnr`

GuillaumeGomez mentioned this pull request Jun 12, 2023

Rustdoc doesn't handle impl section of type definitions #32077

Closed

GuillaumeGomez mentioned this pull request Jul 19, 2023

Generate documentation for type aliases/definitions #113727

Closed

notriddle mentioned this pull request Aug 25, 2023

rustdoc: list matching impls on type aliases #115201

Merged

GuillaumeGomez mentioned this pull request Sep 8, 2023

rustdoc: show inner enum and struct in type definition for concrete type #114855

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[rustdoc] List matching impls on type aliases #112429

[rustdoc] List matching impls on type aliases #112429

GuillaumeGomez commented Jun 8, 2023

This comment has been minimized.

notriddle Jun 8, 2023

GuillaumeGomez Jun 8, 2023 •

edited

Loading

GuillaumeGomez Jun 8, 2023 •

edited

Loading

notriddle Jun 8, 2023

GuillaumeGomez Jun 8, 2023

GuillaumeGomez Jun 8, 2023

notriddle Jun 8, 2023

lcnr Jun 9, 2023

GuillaumeGomez Jun 9, 2023

notriddle commented Jun 8, 2023

bors commented Jun 8, 2023

notriddle commented Jun 8, 2023

lcnr left a comment

lcnr Jun 9, 2023

GuillaumeGomez commented Jun 9, 2023

bors commented Jun 9, 2023

[rustdoc] List matching impls on type aliases #112429

[rustdoc] List matching impls on type aliases #112429

Conversation

GuillaumeGomez commented Jun 8, 2023

This comment has been minimized.

Choose a reason for hiding this comment

GuillaumeGomez Jun 8, 2023 • edited Loading

Choose a reason for hiding this comment

GuillaumeGomez Jun 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

notriddle commented Jun 8, 2023

bors commented Jun 8, 2023

notriddle commented Jun 8, 2023

lcnr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuillaumeGomez commented Jun 9, 2023

bors commented Jun 9, 2023

GuillaumeGomez Jun 8, 2023 •

edited

Loading

GuillaumeGomez Jun 8, 2023 •

edited

Loading